Delete User

Deletes the specified User from the tenant.

DELETE{accelqLoginUrl}/awb/api/2.0/{tenantCode}/administration/users/{userPid}

Headers

HeaderValue
user_idLogin username (email)
api_keyAPI key of the user for authentication
Content-Typeapplication/json
Acceptapplication/json

Parameters

ParameterTypeRequiredDescription
accelqLoginUrlstringYesThe AccelQ login URL for API access.
tenantCodestringYesTenant code for identifying the organization.
userPidstringYesUnique identifier of the user to be deleted
user_idstringYesLogin username (email)
api_keystringYesAPI key of the user for authentication

Responses

204 - User successfully deleted

No response sample available

400 - Bad Request Error

json
{
  "error": "Cannot delete your own user account"
}

403 - Forbidden - User does not have permission to delete users

json
{
  "error": "User does not have authorization to access this feature"
}

404 - User not found

json
{
  "error": "User with pid : '26' doesnot exist."
}

cURL Command Builder

URL Parameters

Headers

Request Sample (cURL)

curl -X DELETE "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/administration/users/${{userPid}}" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"